Dynamic Process Connection properties

Process properties are name/value pairs that you can use to store arbitrary information on a per document level to assist with your integration. One type of process property, a Dynamic Process Connection property, is one that you create to override Connection and extension values at runtime. The Dynamic Process Connection properties are available only for Connector steps in a process. They are not supported for connector calls made in map functions or parameter values within other process steps.

Important

Due to the wider implications of how this feature impacts connector licensing, this feature is currently provisioned only for select accounts. Please contact your Platform account representative for information about how to enable this feature for your account.

Typically, you modify Connection values while configuring a Connector step on the process canvas or when using extensions during deployment. However, the new Dynamic Process Connection properties surpass extensible properties by allowing for Connection properties to be dynamically configured at runtime. These properties can support use cases like integrating data from the same location (such as a database or file server) using different sets of credentials or by dynamically routing API requests to a specific back end from a list of back end URLs.

Setting dynamic process connections

Dynamic Process Connection Properties enable you to set values for Connection component fields that have been declared extensible, including encrypted/password fields, and complex key-value fields such as OAuth 2.0 Authorization and Access Token Parameters, as well as custom connection properties.

It is important to note that for these field types, you can only set values for already defined keys within the Connection component. You cannot dynamically add new keys. The password-type fields are marked with the "[ENCRYPTED]" label, and their values do not appear in the process or document logs.

To override Connection values set in your process or at the extension level, you need to configure both the Set Properties and Connector steps in your process design, as described below.

For detailed steps about how to set dynamic Connections, refer to the topic Creating Dynamic Connections.

To leverage Dynamic Process Connection properties, you must:

1. First enable the Allow dynamic connector properties option on the Connector step's General tab of the Connection you wish to override. If this option is not enabled, only the design-level and extension-level connection values are used at runtime even if the requirements are fulfilled as outlined in the next step.

   note

   If the same Connection component is used multiple times within a process, the Allow dynamic Connection properties option needs to be enabled on each of the Connector steps. If this is not set, the same Connections are executed with varying values at different points in the process.

2. Next, set a list of Dynamic Process Connection properties via the Set Properties steps. By defining property parameters, you dynamically set the values of Connection fields. For example, you can set and use dynamic process connector properties to apply different credentials to a Connection's configuration in order to make an API call as a specific user.

   To override a Connection value or extension properly, the Set Properties step must be positioned before any affected Connectors in your design process.